diagram | ![]() |
||||||||||||
namespace | http://www.cisco.com/AXL/API/10.5 | ||||||||||||
type | extension of axlapi:APIRequest | ||||||||||||
properties |
|
||||||||||||
children | uuid userid firstName middleName lastName newUserid password pin mailid department manager userLocale associatedDevices primaryExtension associatedPc associatedGroups enableCti digestCredentials phoneProfiles defaultProfile presenceGroupName subscribeCallingSearchSpaceName enableMobility enableMobileVoiceAccess maxDeskPickupWaitTime remoteDestinationLimit passwordCredentials pinCredentials primaryDevice enableEmcc ctiControlledDeviceProfiles patternPrecedence numericUserId mlppPassword customUserFields homeCluster imAndPresenceEnable serviceProfile lineAppearanceAssociationForPresences directoryUri telephoneNumber title mobileNumber homeNumber pagerNumber removeExtensionsInfo addExtensionsInfo extensionsInfo selfService userProfile calendarPresence ldapDirectoryName userIdentity nameDialing ipccExtension convertUserAccount | ||||||||||||
used by |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:complexType name="UpdateUserReq"> <xsd:complexContent> <xsd:extension base="axlapi:APIRequest"> <xsd:sequence> <xsd:choice> <xsd:element name="uuid" type="axlapi:XUUID"/> <xsd:element name="userid" type="xsd:string" nillable="false" minOccurs="1" maxOccurs="1"/> </xsd:choice> <xsd:element name="firstName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="middleName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="lastName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="newUserid" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="password" type="xsd:string" minOccurs="0" maxOccurs="1"/> <xsd:element name="pin" type="xsd:string" minOccurs="0" maxOccurs="1"/> <xsd:element name="mailid" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="department" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="manager" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="userLocale" type="axlapi:XUserLocale" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="associatedDevices" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Also known as controlled devices.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="device" type="axlapi:String50" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Name of device.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="primaryExtension" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Only DNs associated with the associatedDevices of the User can be used as primary extension.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="pattern" type="axlapi:String255" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>DN or Pattern</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="routePartitionName" type="axlapi:String50" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Route Partition to which the DN is associated.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="associatedPc" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="associatedGroups" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="userGroup" minOccurs="0" maxOccurs="unbounded"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="name" type="axlapi:String100" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Name of User Group</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="userRoles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="userRole" type="axlapi:String100" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>READ ONLY: Name of the User Role associated with the user group will be taken.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="enableCti" type="axlapi:boolean" default="true" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="digestCredentials" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="phoneProfiles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="profileName" type="axlapi:XFkType" minOccurs="1" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="defaultProfile" type="axlapi:XFkType" minOccurs="0" maxOccurs="1"/> <xsd:element name="presenceGroupName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="subscribeCallingSearchSpaceName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="enableMobility" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="enableMobileVoiceAccess" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="maxDeskPickupWaitTime" type="axlapi:XInteger" default="10000" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="remoteDestinationLimit" type="axlapi:XInteger" default="4" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Remote Destination Limit must be a number in the range 1 to 10. Not Nullable.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="passwordCredentials" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Not Applicable for Add. Credential configuration for password.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="pwdCredPolicyName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredUserCantChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredUserMustChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredDoesNotExpire" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredTimeChanged" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredTimeAdminLockout" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredLockedByAdministrator" type="axlapi:boolean" minOccurs="0" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="pinCredentials" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Not Applicable for add. These groups get automatically added once an user is added. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="pinCredPolicyName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredUserCantChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredUserMustChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredDoesNotExpire" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredTimeChanged" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredTimeAdminLockout" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredLockedByAdministrator" type="axlapi:boolean" minOccurs="0" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="primaryDevice" type="axlapi:XFkType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Primary Device for mobility users</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="enableEmcc" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="ctiControlledDeviceProfiles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="profileName" type="axlapi:XFkType" minOccurs="1" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="patternPrecedence" type="axlapi:XPatternPrecedence" default="Default" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="numericUserId" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="mlppPassword" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="customUserFields" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:choice minOccurs="1"> <xsd:element name="customUserField" type="axlapi:XUserCustomUserField" minOccurs="0" maxOccurs="5"> <xsd:annotation> <xsd:documentation>This Tag is valid only for GetUser</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> </xsd:complexType> </xsd:element> <xsd:element name="homeCluster" type="axlapi:boolean" default="true" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="imAndPresenceEnable" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="serviceProfile" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="lineAppearanceAssociationForPresences" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Applicable for Controlled Devices</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="lineAppearanceAssociationForPresence" type="axlapi:XLineAppearanceAssociationForPresence" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="directoryUri" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="telephoneNumber" type="axlapi:String255" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This field also corresponds to the field 'Number Displayed in Directory' for the Quick User/phone Add page.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="title" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="mobileNumber" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="homeNumber" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pagerNumber" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:choice minOccurs="0"> <xsd:sequence minOccurs="0"> <xsd:element name="removeExtensionsInfo" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> <xsd:element name="addExtensionsInfo" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:element name="extensionsInfo" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> </xsd:choice> <xsd:element name="selfService" type="axlapi:UniqueString50" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="userProfile" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="calendarPresence" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="ldapDirectoryName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="userIdentity" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Value should be of of the format user@domain</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="nameDialing" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="ipccExtension" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs only.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="convertUserAccount" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>These tags are for Get/UpdateUser APIs only.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> |
diagram | ![]() |
||||||
type | axlapi:XUUID | ||||||
properties |
|
||||||
facets |
|
||||||
source | <xsd:element name="uuid" type="axlapi:XUUID"/> |
diagram | ![]() |
||||
type | xsd:string | ||||
properties |
|
||||
source | <xsd:element name="userid" type="xsd:string" nillable="false" minOccurs="1" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="firstName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="middleName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="lastName" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="newUserid" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
type | xsd:string | ||||||
properties |
|
||||||
source | <xsd:element name="password" type="xsd:string" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
type | xsd:string | ||||||
properties |
|
||||||
source | <xsd:element name="pin" type="xsd:string" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="mailid" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="department" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="manager" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:XUserLocale | ||||||||
properties |
|
||||||||
source | <xsd:element name="userLocale" type="axlapi:XUserLocale" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | device | ||||||
annotation |
|
||||||
source | <xsd:element name="associatedDevices" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Also known as controlled devices.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="device" type="axlapi:String50" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Name of device.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:String50 | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="device" type="axlapi:String50" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Name of device.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||
properties |
|
||||||
children | pattern routePartitionName | ||||||
annotation |
|
||||||
source | <xsd:element name="primaryExtension" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Only DNs associated with the associatedDevices of the User can be used as primary extension.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="pattern" type="axlapi:String255" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>DN or Pattern</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="routePartitionName" type="axlapi:String50" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Route Partition to which the DN is associated.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:String255 | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="pattern" type="axlapi:String255" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>DN or Pattern</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:String50 | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="routePartitionName" type="axlapi:String50" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Route Partition to which the DN is associated.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="associatedPc" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | userGroup | ||||||
source | <xsd:element name="associatedGroups" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="userGroup" minOccurs="0" maxOccurs="unbounded"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="name" type="axlapi:String100" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Name of User Group</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="userRoles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="userRole" type="axlapi:String100" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>READ ONLY: Name of the User Role associated with the user group will be taken.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
properties |
|
||||||
children | name userRoles | ||||||
source | <xsd:element name="userGroup" minOccurs="0" maxOccurs="unbounded"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="name" type="axlapi:String100" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Name of User Group</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="userRoles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="userRole" type="axlapi:String100" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>READ ONLY: Name of the User Role associated with the user group will be taken.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:String100 | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="name" type="axlapi:String100" minOccurs="1" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Name of User Group</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||
properties |
|
||||||
children | userRole | ||||||
source | <xsd:element name="userRoles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="userRole" type="axlapi:String100" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>READ ONLY: Name of the User Role associated with the user group will be taken.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:String100 | ||||||
properties |
|
||||||
facets |
|
||||||
annotation |
|
||||||
source | <xsd:element name="userRole" type="axlapi:String100" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>READ ONLY: Name of the User Role associated with the user group will be taken.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="enableCti" type="axlapi:boolean" default="true" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="digestCredentials" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | profileName | ||||||
source | <xsd:element name="phoneProfiles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="profileName" type="axlapi:XFkType" minOccurs="1" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="profileName" type="axlapi:XFkType" minOccurs="1" maxOccurs="unbounded"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="defaultProfile" type="axlapi:XFkType" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="presenceGroupName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="subscribeCallingSearchSpaceName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="enableMobility" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="enableMobileVoiceAccess" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||
type | axlapi:XInteger | ||||||||||
properties |
|
||||||||||
annotation |
|
||||||||||
source | <xsd:element name="maxDeskPickupWaitTime" type="axlapi:XInteger" default="10000" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||||
type | axlapi:XInteger | ||||||||||
properties |
|
||||||||||
annotation |
|
||||||||||
source | <xsd:element name="remoteDestinationLimit" type="axlapi:XInteger" default="4" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Remote Destination Limit must be a number in the range 1 to 10. Not Nullable.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||
properties |
|
||||||
children | pwdCredPolicyName pwdCredUserCantChange pwdCredUserMustChange pwdCredDoesNotExpire pwdCredTimeChanged pwdCredTimeAdminLockout pwdCredLockedByAdministrator | ||||||
annotation |
|
||||||
source | <xsd:element name="passwordCredentials" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Not Applicable for Add. Credential configuration for password.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="pwdCredPolicyName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredUserCantChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredUserMustChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredDoesNotExpire" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredTimeChanged" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredTimeAdminLockout" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="pwdCredLockedByAdministrator" type="axlapi:boolean" minOccurs="0" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="pwdCredPolicyName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pwdCredUserCantChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pwdCredUserMustChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pwdCredDoesNotExpire" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="pwdCredTimeChanged" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="pwdCredTimeAdminLockout" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
type | axlapi:boolean | ||||||
properties |
|
||||||
facets |
|
||||||
source | <xsd:element name="pwdCredLockedByAdministrator" type="axlapi:boolean" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | pinCredPolicyName pinCredUserCantChange pinCredUserMustChange pinCredDoesNotExpire pinCredTimeChanged pinCredTimeAdminLockout pinCredLockedByAdministrator | ||||||
annotation |
|
||||||
source | <xsd:element name="pinCredentials" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Not Applicable for add. These groups get automatically added once an user is added. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="pinCredPolicyName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredUserCantChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredUserMustChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredDoesNotExpire" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredTimeChanged" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredTimeAdminLockout" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> <xsd:element name="pinCredLockedByAdministrator" type="axlapi:boolean" minOccurs="0" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="pinCredPolicyName" type="axlapi:XFkType" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pinCredUserCantChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pinCredUserMustChange" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pinCredDoesNotExpire" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="pinCredTimeChanged" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="pinCredTimeAdminLockout" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
type | axlapi:boolean | ||||||
properties |
|
||||||
facets |
|
||||||
source | <xsd:element name="pinCredLockedByAdministrator" type="axlapi:boolean" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="primaryDevice" type="axlapi:XFkType" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Primary Device for mobility users</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="enableEmcc" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | profileName | ||||||
source | <xsd:element name="ctiControlledDeviceProfiles" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="profileName" type="axlapi:XFkType" minOccurs="1" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="profileName" type="axlapi:XFkType" minOccurs="1" maxOccurs="unbounded"/> |
diagram | ![]() |
||||||||||
type | axlapi:XPatternPrecedence | ||||||||||
properties |
|
||||||||||
source | <xsd:element name="patternPrecedence" type="axlapi:XPatternPrecedence" default="Default" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="numericUserId" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="mlppPassword" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | customUserField | ||||||
source | <xsd:element name="customUserFields" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:choice minOccurs="1"> <xsd:element name="customUserField" type="axlapi:XUserCustomUserField" minOccurs="0" maxOccurs="5"> <xsd:annotation> <xsd:documentation>This Tag is valid only for GetUser</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:XUserCustomUserField | ||||||
properties |
|
||||||
children | name value | ||||||
annotation |
|
||||||
source | <xsd:element name="customUserField" type="axlapi:XUserCustomUserField" minOccurs="0" maxOccurs="5"> <xsd:annotation> <xsd:documentation>This Tag is valid only for GetUser</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="homeCluster" type="axlapi:boolean" default="true" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:boolean | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="imAndPresenceEnable" type="axlapi:boolean" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="serviceProfile" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
properties |
|
||||||
children | lineAppearanceAssociationForPresence | ||||||
annotation |
|
||||||
source | <xsd:element name="lineAppearanceAssociationForPresences" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Applicable for Controlled Devices</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:element name="lineAppearanceAssociationForPresence" type="axlapi:XLineAppearanceAssociationForPresence" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:XLineAppearanceAssociationForPresence | ||||||
properties |
|
||||||
children | laapAssociate laapProductType laapDeviceName laapDirectory laapPartition laapDescription | ||||||
source | <xsd:element name="lineAppearanceAssociationForPresence" type="axlapi:XLineAppearanceAssociationForPresence" minOccurs="0" maxOccurs="unbounded"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="directoryUri" type="xsd:string" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | axlapi:String255 | ||||||||
properties |
|
||||||||
facets |
|
||||||||
annotation |
|
||||||||
source | <xsd:element name="telephoneNumber" type="axlapi:String255" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>This field also corresponds to the field 'Number Displayed in Directory' for the Quick User/phone Add page.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="title" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="mobileNumber" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="homeNumber" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="pagerNumber" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||
type | extension of axlapi:XCommonMembersExtension | ||||||
properties |
|
||||||
children | extension | ||||||
source | <xsd:element name="removeExtensionsInfo" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:XExtension | ||||||
properties |
|
||||||
children | sortOrder pattern routePartition linePrimaryUri partition | ||||||
annotation |
|
||||||
source | <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||
type | extension of axlapi:XCommonMembersExtension | ||||||
properties |
|
||||||
children | extension | ||||||
source | <xsd:element name="addExtensionsInfo" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:XExtension | ||||||
properties |
|
||||||
children | sortOrder pattern routePartition linePrimaryUri partition | ||||||
annotation |
|
||||||
source | <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||
type | extension of axlapi:XCommonMembersExtension | ||||||
properties |
|
||||||
children | extension | ||||||
annotation |
|
||||||
source | <xsd:element name="extensionsInfo" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="axlapi:XCommonMembersExtension"> <xsd:sequence minOccurs="0"> <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | ![]() |
||||||
type | axlapi:XExtension | ||||||
properties |
|
||||||
children | sortOrder pattern routePartition linePrimaryUri partition | ||||||
annotation |
|
||||||
source | <xsd:element name="extension" type="axlapi:XExtension" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>These tags are for Quick User/Phone Add page</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||
type | axlapi:UniqueString50 | ||||||||
properties |
|
||||||||
facets |
|
||||||||
source | <xsd:element name="selfService" type="axlapi:UniqueString50" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="userProfile" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||
type | axlapi:boolean | ||||||||||
properties |
|
||||||||||
facets |
|
||||||||||
source | <xsd:element name="calendarPresence" type="axlapi:boolean" default="false" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
source | <xsd:element name="ldapDirectoryName" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
annotation |
|
||||||||
source | <xsd:element name="userIdentity" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Value should be of of the format user@domain</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||
type | xsd:string | ||||||||
properties |
|
||||||||
source | <xsd:element name="nameDialing" type="xsd:string" nillable="false" minOccurs="0" maxOccurs="1"/> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="ipccExtension" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs only.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | ![]() |
||||||||||||
type | axlapi:XFkType | ||||||||||||
properties |
|
||||||||||||
attributes |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="convertUserAccount" type="axlapi:XFkType" nillable="true" minOccurs="0" maxOccurs="1"> <xsd:annotation> <xsd:documentation>These tags are for Get/UpdateUser APIs only.</xsd:documentation> </xsd:annotation> </xsd:element> |